<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>nrf51/Include/ext_sensors/cherry8x16.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="alias.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="alias.js"></script>

<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>


<script type="text/javascript">
  jQuery(document).ready(function () {
    if(gref){ // Number all _img and _table classes
      gref();
    }
  });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->

<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">nRF51 General Code Examples
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('cherry8x16_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">nrf51/Include/ext_sensors/cherry8x16.h File Reference</div>  </div>
</div>
<div class="contents">

<p>Cherry 8x16 keyboard matrix driver.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdbool.h&gt;</code><br/>
<code>#include &lt;stdint.h&gt;</code><br/>
</div>
<p><a href="cherry8x16_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga96705cbd765dd973315e95ac650c68e8"></a><!-- doxytag: member="cherry8x16.h::CHERRY8x16_MAX_NUM_OF_PRESSED_KEYS" ref="ga96705cbd765dd973315e95ac650c68e8" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#ga96705cbd765dd973315e95ac650c68e8">CHERRY8x16_MAX_NUM_OF_PRESSED_KEYS</a>&#160;&#160;&#160;6</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of pressed keys kept in buffers. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacb3e11a73fa9f827d1cb395d7474886b"></a><!-- doxytag: member="cherry8x16.h::CHERRY8x16_DEFAULT_KEY_LOOKUP_MATRIX" ref="gacb3e11a73fa9f827d1cb395d7474886b" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#gacb3e11a73fa9f827d1cb395d7474886b">CHERRY8x16_DEFAULT_KEY_LOOKUP_MATRIX</a>&#160;&#160;&#160;(const uint8_t*)0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If passed to <a class="el" href="group__nrf__drivers__cherry8x16.html#ga4d88841d6f21173bb304d2bd41f67c91">cherry8x16_init</a>, default lookup matrix will be used. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga41430f808d8d3b096877de667eb4d086"></a><!-- doxytag: member="cherry8x16.h::KEY_PACKET_MODIFIER_KEY_INDEX" ref="ga41430f808d8d3b096877de667eb4d086" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#ga41430f808d8d3b096877de667eb4d086">KEY_PACKET_MODIFIER_KEY_INDEX</a>&#160;&#160;&#160;(0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Index in the key packet where modifier keys such as ALT and Control are stored. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6c26e14ce8c196c829b01213ebe2a257"></a><!-- doxytag: member="cherry8x16.h::KEY_PACKET_RESERVED_INDEX" ref="ga6c26e14ce8c196c829b01213ebe2a257" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#ga6c26e14ce8c196c829b01213ebe2a257">KEY_PACKET_RESERVED_INDEX</a>&#160;&#160;&#160;(1)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Index in the key packet where OEMs can store information. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa44734bdd788259bfec3a2d020b88ae5"></a><!-- doxytag: member="cherry8x16.h::KEY_PACKET_KEY_INDEX" ref="gaa44734bdd788259bfec3a2d020b88ae5" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#gaa44734bdd788259bfec3a2d020b88ae5">KEY_PACKET_KEY_INDEX</a>&#160;&#160;&#160;(2)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Start index in the key packet where pressed keys are stored. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3a5a7559365a12f6ea3955768b8b5382"></a><!-- doxytag: member="cherry8x16.h::KEY_PACKET_MAX_KEYS" ref="ga3a5a7559365a12f6ea3955768b8b5382" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#ga3a5a7559365a12f6ea3955768b8b5382">KEY_PACKET_MAX_KEYS</a>&#160;&#160;&#160;(6)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of keys that can be stored into the key packet. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga61bbda0c3b4c6126d2dd65a0b2cdc3ea"></a><!-- doxytag: member="cherry8x16.h::KEY_PACKET_SIZE" ref="ga61bbda0c3b4c6126d2dd65a0b2cdc3ea" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#ga61bbda0c3b4c6126d2dd65a0b2cdc3ea">KEY_PACKET_SIZE</a>&#160;&#160;&#160;(KEY_PACKET_KEY_INDEX+KEY_PACKET_MAX_KEYS)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Total size of the key packet in bytes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf91da4c4186290332d254c5f7aa1215a"></a><!-- doxytag: member="cherry8x16.h::KEY_PACKET_NO_KEY" ref="gaf91da4c4186290332d254c5f7aa1215a" args="" -->
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#gaf91da4c4186290332d254c5f7aa1215a">KEY_PACKET_NO_KEY</a>&#160;&#160;&#160;(0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to be stored to key index to indicate no key is pressed. <br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#gabb88a2cc8f85ba70003398a2e9e26a5e">cherry8x16_status_t</a> { <a class="el" href="group__nrf__drivers__cherry8x16.html#ggabb88a2cc8f85ba70003398a2e9e26a5ea7c38ac713571ced5641f27dc14091f8d">CHERRY8x16_OK</a>, 
<a class="el" href="group__nrf__drivers__cherry8x16.html#ggabb88a2cc8f85ba70003398a2e9e26a5ea163e64073d78aae09ebdb9c5edcc634b">CHERRY8x16_NOT_DETECTED</a>, 
<a class="el" href="group__nrf__drivers__cherry8x16.html#ggabb88a2cc8f85ba70003398a2e9e26a5ea5d6d998931af38e703f9569f89858fcc">CHERRY8x16_INVALID_PARAMETER</a>
 }</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nrf__drivers__cherry8x16.html#gabb88a2cc8f85ba70003398a2e9e26a5e">cherry8x16_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#ga4d88841d6f21173bb304d2bd41f67c91">cherry8x16_init</a> (const uint8_t volatile *row_port, uint16_t *column_port, const uint8_t *key_lookup_matrix)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nrf__drivers__cherry8x16.html#ga0079fdc53514fc2c48f98779f0c24719">cherry8x16_new_packet</a> (const uint8_t **p_key_packet, uint8_t *p_key_packet_size)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Cherry 8x16 keyboard matrix driver. </p>

<p>Definition in file <a class="el" href="cherry8x16_8h_source.html">cherry8x16.h</a>.</p>
</div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="cherry8x16_8h.html">cherry8x16.h</a>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">
      Copyright &copy 2006-2011 <a href="http://www.nordicsemi.no" style="text-decoration:none">Nordic Semiconductor</a>.
      All Rights Reserved.
      <a href="disclaimer.html">Disclaimer</a>
    </li>
   </ul>
 </div>


</body>
</html>
